/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.utils.logger;

import org.dei.perla.utils.logger.LogRecord.Verbosity;

/**
 * Classa astratta che deve essere ereditata da un Logger per ricevere 
 * le notifiche da inserire nel log
 */
public abstract class Logger implements ILogger {

	/**
	 * Indica se il Logger è stato avviato
	 */
	private boolean pLogStarted;
	
	/**
	 * Eventuale messaggio di errore generato dal Logger
	 */
	private String pErrorMessage;
	
	/**
	 * Livello di verbosità corrente
	 */
	private Verbosity pVerbosityLevel;
		
	
	/**
	 * Costruttore
	 */
	public Logger() {
		
		// Inizializza le variabili
		this.pLogStarted = false;
		this.pErrorMessage = "";
		
		// Imposta il livello di verbosità predefinito
		this.setVerbosity(Verbosity.Medium);		
	}	
	
	
	/**
	 * Imposta il livello di verbosità del Logger
	 */
	public final void setVerbosity(LogRecord.Verbosity parVerbosityLevel) {
		
		this.pVerbosityLevel = parVerbosityLevel;
	}
		
	
	/**
	 * Restituisce il livello di verbosità del Logger
	 */
	public final LogRecord.Verbosity getVerbosity() {
		
		return this.pVerbosityLevel;
	}
	
	
	/**
	 * Restituisce l'eventuale messaggio di errore generato dal Logger
	 */
	public String getErrorMessage() {
		
		return this.pErrorMessage;
	}
	
	/**
	 * Imposta il messaggio di errore del Logger
	 */
	protected void setErrorMessage(String parErrorMessage) {
	
		this.pErrorMessage = parErrorMessage;
	}
	
	
	/**
	 * Inizializza e avvia il Logger
	 * @return True se non si sono verificati errori
	 */
	public final boolean start() {
		
		if(!this.pLogStarted)
			this.pLogStarted = this.logStart();
		
		return this.pLogStarted;
	}
	
	
	/**
	 * Termina il Logger
	 */
	public final void stop() {
		
		if(this.pLogStarted)
			this.logStop();
	}
	
	
	/**
	 * Resetta il Logger
	 */
	public final void reset() {
		
		if(this.pLogStarted)
			this.logReset();
	}
	
	
	/**
	 * Aggiunge un nuovo record al Logger
	 * @return True se non si sono verificati errori
	 */	
	public final boolean add(LogRecord parLogRecord) {
		
		if((this.pLogStarted) && (parLogRecord != null))
			if(this.pVerbosityLevel.Show(parLogRecord.getVerbosity()))
				return this.logAdd(parLogRecord);
		return true;
	}
	
	
	/**
	 * Metodo overridabile per inizializzare il Logger
	 */
	protected boolean logStart() {
		
		return true;
	}
	
	
	/**
	 * Metodo overridabile per arrestare il Logger
	 */
	protected void logStop() {
		
	}
	
	
	/**
	 * Metodo overridabile per resettare il contenuto del log
	 */
	protected abstract void logReset();
	
	
	/**
	 * Metodo overridabile per aggiungere una voce al log
	 */
	protected abstract boolean logAdd(LogRecord parLogRecord);
		
}
